home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 3 / Amiga Tools 3.iso / wb-tools / born21 / born.doc < prev    next >
Encoding:
Text File  |  1995-04-30  |  3.9 KB  |  96 lines
  1. ----------------------------------------------------------------------------
  2.  
  3.                                  BORN V2.10
  4.                                  
  5.                           Coded by The Last Viking
  6.  
  7.  
  8. Born is a reminder program, which started of as a birthday reminder program
  9. but it has now evolved into a reminder for anything. The idea of the program
  10. is to remind the user of general events happening on specific days each year.
  11. Like Christmas, Valentines day, your grandmother's birthday and
  12. Anniversaries and such.
  13.  
  14. The born package consists of 4 programs:
  15.  
  16. Born     -> ready compiled Amiga version of the program.
  17. Born.dta -> sample datafile
  18. Born.doc -> this documentation file.
  19. Born.c   -> the sourcecode, as the program is written in ANSI-C, it should
  20.         extremely easy to port it to other systems. It's a pure shell
  21.         based program, so you don't have to worry about windows with
  22.         bells and whistles.
  23.         
  24. If you are missing one of the files above, then you can email me or try
  25. looking on AmiNet. This program is public domain so spread it as you wish,
  26. but it would be nice if you spread the whole lha-archieve file when you do
  27. so.
  28.  
  29. Now to the program itself, there are 3 ways to start born.
  30.  
  31.  born filename] silent    -this one will run born silently. If nothing is
  32.                 happening then you won't get any output at all.
  33.  born filename           -Born prints a oneliner, then prints new messages.
  34.  born help          -This is a short help function.
  35.  
  36. All the parameters must be written in lowercase. Born is very strict when it
  37. comes to parameter and syntax accuracy. Here is an example of how it can be
  38. executed: Born s:born.dta silent. Which will start born, load the data from
  39. the s: directory and run it silent (no output unless it's necessary).
  40.  
  41. But before you run born, you would have to set up a datafile, Born.dta, or
  42. you can call it whatever you want. There is some examples in the Born.dta
  43. file of how you can set it up. 
  44.  
  45. The top of the message can have N remark lines. This isn't necessary but
  46. it's a good way of labeling the file. If you have many remark lines then the
  47. running of the program will become slower. After these remark lines you HAVE
  48. to have a open line. If you remove all the remarks you will still have to
  49. have that open line. If you don't do that, then you will get a read error
  50. message. Then after that open line you can write the data in the following
  51. format:
  52.  
  53. dd-mm da notice
  54.  
  55. Where dd is days, mm is month, da is days in advance and notice is the text
  56. that you want written out on those specific days. da can be max 9 because 9
  57. days in advance is the max that the programs allow you to be reminded of an
  58. event. The last line in in this script has to be: XX-XX X END OF FILE.
  59.  
  60. Here's some examples:
  61.  
  62. 19-08 4  This will work fine.
  63. 19-8 2   This will not work because all numbers in the date needs to be
  64.      written with two digits.
  65. 4-03 4   This will not work for the same reasons.
  66. 04-23 4  Uh, the DAY is the first one and the MONTH is the second digit!
  67. 01-01 10 This will not work either, as the max for DA is 9.
  68.  
  69. That just about wraps it up. I think, if you are on internet, then you can
  70. send me a birthday greeting at the 12'th of July :) Feedback is always good.
  71. My address are:
  72.  
  73. Pål D. Ekran            Email: paalde@stud.cs.uit.no
  74. Mobekkgata 26
  75. 8600 MO
  76. NORWAY
  77.  
  78. ----------------------------------------------------------------------------
  79. Evolution history:
  80.  
  81. v1.0 Old unstable Modula-2 code. Crashed on bad days.
  82.  
  83. v1.1 Another Modula-2 version. This one works, and it has the date written
  84.      in EC.
  85.  
  86. v2.0 Born is no longer just a birthday reminder, it reminds you of all kinds
  87.      of events. It also have other new features, like a silent mode and
  88.      and adjustable day in advance where you can select when you want to be
  89.      reminded. The code was totally rewritten in C, and it is much cleaner
  90.      than the previous Modula-2 code.
  91.  
  92. V2.1 A upshine of v2.0.
  93.  
  94. ----------------------------------------------------------------------------
  95.  
  96.